***************************************************************************
***                            #QuizPL TeaM                             ***
***                                                                     ***
***                  Najlepszy kanał quizowy na IRC-u!                  ***
***************************************************************************
***                       https://www.quizpl.net                        ***
***                         kontakt@quizpl.net                          ***
***************************************************************************

Witaj drogi Quizowiczu. Oto instrukcja, dzięki której będziesz mógł/mogła samodzielnie napisać i puścić swoją premierę 
quizową na kanale #QuizPL. :)

Pełny poradnik znajdziesz pod adresem: https://www.quizpl.net/poradnik

############################
### I. Instalacja mIRCa. ###
############################

Jeśli masz już ściągniętego i poprawnie skonfigurowanego mIRCa możesz pominąć ten punkt i po uruchomieniu mIRCa dodać 
do ulubionych kanał #QuizPL oraz wejść na kanał poleceniem /join #QuizPL


Aby zaś ściągnąć mIRCa i móc grać na kanale #QuizPL wykonaj poniższe kroki:

1. Ściągnij plik https://www.quizpl.net/viewforum.php?f=79
2. Rozpakuj powyższy plik do dowolnego katalogu, np. C:\Program Files\
3. Przeczytaj zamieszczony tam plik "-= Przeczytaj mnie =-.txt"
4. Uruchom plik mIRC.exe
5. Kliknij teraz na pierwszą ikonkę pod menu (tą z piorunkiem) lub wpisz na dole "/server polska.irc.pl" (bez 
   cudzysłowu) i wciśnij enter. Jeśli połączyłeś się z serwerem i automatycznie otworzyło się nowe okienko, to jesteś 
   już na kanale #QuizPL i od teraz możesz zdobywać punkciki!


Alternatywnie możesz ściągnąć mIRCa ze strony autora programu https://www.mirc.com/get.html lecz wówczas musisz 
samodzielnie skonfigurować program lub napisać na adres kontakt@quizpl.net by uzyskać naszą pomoc.

###############################
### II. Instalacja skryptu. ###
###############################

Rozpakuj to archiwum i przenieś wszystkie pliki do głównego katalogu mIRCa, np. C:\Program Files\mIRC\ oraz uruchom 
plik mirc.exe

Teraz, by móc korzystać ze skryptu (w dniu puszczania quizu), należy go wgrać do uruchomionego wcześniej mIRCa. 
Uzyskasz to poleceniem:

/load -a milioner.ini

W okienku statusu powinien pojawić się podobny do tego napis:

* Loaded aliases 'C:\...\milioner.ini'

#############################################
### III. Przygotowanie pliku z pytaniami. ###
#############################################

Ten rodzaj quizu oparty jest na wiedzy graczy i polega na wybraniu poprawnej odpowiedzi z czterech podanych, przy czym 
tylko pierwsza podana odpowiedź się liczy. Wybranie niepoprawnej może prowadzić do utraty punktów.

Gdy zdecydujesz się napisać swój quiz i puścić go na kanale - wybierz sobie dziedzinę z jakiej chciałbyś napisać quiz 
(może być także wiedza ogólna).

Plik z pytaniami musi być w odpowiedniej postaci. Format pliku polega na tym, że pytanie umieszczamy w pierwszej 
linijce, w kolejnej linijce poprawną odpowiedź i w trzech kolejnych linijkach mylące odpowiedzi (nie obawiaj się, 
skrypt wyświetli odpowiedzi w losowej kolejności). Przykład:

Jakiego pierwiastka jest najwiecej w atmosferze ziemskiej?
azot
tlen
fosfor
chlor
Skad pochodzi Conan Barbarzynca?
z Cimmerii
z Rivii
z Oz
z Modoru

Przykładowy quiz znajdziesz w pliku "przyklad.txt", zaznajom się z nim.


Podstawowe zasady układania quizów:

- format pliku musi być poprawny, bo quiz utknie na błędnym pytaniu (unikaj zbędnych spacji i wystrzegaj się pustych 
  linii, mniej lub więcej niż cztery odpowiedzi)
- nie używaj w pytaniach i odpowiedziach znaków diakrytycznych (ą, ć, ę, ł, ń, ó, ś, ź, ż)
- pytania i odpowiedzi nie mogą zawierać błędów ortograficznych, stylistycznych, interpunkcyjnych i merytorycznych
- pytania zaczynaj wielką literą, a odpowiedzi małą, chyba że są to nazwy własne
- pytania nie mogą być ze sobą powiązane (bez nawiązywania do treści poprzednich)
- unikaj długich odpowiedzi
- nie pisz zbyt długich, opisowych pytań - skonkretyzuj je
- nie używaj słów niecenzuralnych, jeśli to cytat z filmu lub piosenki użyj gwiazdki ("*") do cenzury


Gdy już utworzysz zestaw ok. 40 pytań (na przykład w windowsowym notatniku, ale nie w Wordzie!), to zapisz je w pliku, 
w głównym katalogu z mIRCem. Pamiętaj jednak by nazwa pliku nie zawierała spacji.

################################
### IV. Puszczenie premiery. ###
################################

Kiedy napiszesz już quiz i ustalisz z operatorami kanału dzień i godzinę premiery - możesz przystąpić do jej 
realizacji w wyznaczonym terminie. Nie zapomnij tylko o wgraniu skryptu (patrz punkt II). ;)

Skrypt zawiera wiele poleceń. Pełną ich listę uzyskasz poleceniem: /mkom

Aby uruchomić quiz otwórz okno kanału #QuizPL i wpisz:

/mon #QuizPL

W razie potrzeby możesz zmienić opóźnienie między poszczególnymi pytaniami (domyślnie jest to 20 sekund) poleceniem: 
/minterwal 10 oraz czas trwania jednego pytania (domyślnie jest to 20 sekund): /mczas 30

Skrypt pozwala w różny sposób reagować na odpowiedzi graczy:

- domyślny i zalecany tryb rozgrywki - gracze dostają ukryty dodatkowy punkt za każdą odpowiedź (dobrą i złą), przez 
co przychodzący pod koniec quizu mają mniejszą szansę na wygranie, wpisz:

/mtryb punkt

- alternatywny tryb skryptu:

/mtryb normal

Domyślnie odpowiedzi udzielane są prywatnie puszczającemu quiz. Jeśli chcesz umożliwić odpowiadanie także na kanale, 
to wpisz: /mtryb pub

Domyślnie do odpowiedzi przypisywane są literki a/b/c/d. Jeśli chcesz wybrać np. format 1/2/3/4, to wpisz: /mtryb 1234 
(można podać dowolne 4 znaki, byle różne)

Skrypt zacznie zadawać pytania z pliku (za "przyklad.txt" podaj nazwę własnego pliku z pytaniami) po wpisaniu:

/mplik przyklad.txt

*** Teraz gracze grają i cieszą się z Twojej premiery. ;) ***

W sytuacji gdyby quiz się utknął (z powodu błędu w pliku z pytaniami), to nie panikuj. Wpisz wtedy dwukrotnie 
polecenie /mpauza Spowoduje to pominięcie błędnego pytania i przejście do kolejnego. W przypadku poważnych błędów w 
formacie w pliku z pytaniami koniecznym może się okazać pominięcie więcej niż jednego pytania lub wprowadzenie 
poprawek w pliku z pytaniami w trakcie premiery.

Po zakończeniu premiery trzeba wyświetlić wyniki. Uczynisz to poleceniem:

/mstat

Na koniec zamykasz quiz poleceniem:

/moff


Po zakończeniu i zamknięciu quizu możesz (zalecane), ale nie musisz wyładować skrypt z mIRCa. Dokonasz tego 
poleceniem:

/unload -a milioner.ini

Aby puścić kolejną premierkę należy ponownie wgrać skrypt poleceniem /load (patrz punkt II).


Uwaga, nie zapomnij by po zakończeniu premiery przysłać plik z pytaniami, temat quizu wraz z datą puszczenia oraz 
pełne wyniki na adres kanałowy: kontakt@quizpl.net Pytania zostaną wówczas dodane do bazy naszego quizbota i wszyscy 
będą mogli się nimi cieszyć jeszcze przez długie lata ;)

##############################
### V. Polecenia kanałowe. ###
##############################

W trakcie trwania premiery quizowej dla graczy dostępne są specjalne polecenia. Pamiętaj, że z uwagi na specyficzny 
sposób funkcjonowania mIRCa te polecenia nie są dostępne dla puszczającego premierę.

Wyświetlenie własnej punktacji: !ile

Wyświetlenie zasad punktowania: !zasady

#################################
### VI. Informacje dodatkowe. ###
#################################

Skrypt ten jest rozszerzoną wersją standardowych milionerów o przyznawanie dodatkowych punktów za ciąg poprawnych 
odpowiedzi każdego z graczy oraz bonusowe punkty jeśli dany gracz jako jedyny poprawnie odpowiedział. Dodatkowo 
pytania są zabezpieczone antygooglerem (tak jak w naszym quizbocie) przed kopiowaniem ich do Google i oszukiwaniem 
(googlowaniem). Kolejne odpowiedzi chronione są przed serią takich samych symboli przypisywanych do poprawnej 
odpowiedzi (by nie było ciągle "C"). Quiz odbywa się na kanale, ale gracze udzielają odpowiedzi prywatnie 
puszczającemu quiz.

###################################
### VII. Informacje o skrypcie. ###
###################################

Wersja: Milionerzy 3.4
Autor: KrzS
Rozbudowa: wilk (odpowiadanie na priv i opcjonalnie na kanale, wybór odpowiedzi a/b/c/d, 1/2/3/4 lub innych poprzez 
   rozbudowane polecenie /mtryb, ponowne przemieszanie by uniknąć serii odpowiedzi, alias /mdelay, możliwość 
   wyłączania bonusów, możliwość wyłączenia antygooglera, zapisywanie ustawień w pliku)


Miłej zabawy życzy,
Ekipa #QuizPL.
